Direct Integration API

(0 reviews)

Party Proof of Identity

Sample Request

{
    "Package": {
        "Content": {
            "Application": {
                "PersonApplicant": [
                    {
                        "ProofOfIdentity": [
                            {
                                "@DOBVerified": "No",
                                "@DateOfIssue": "2024-02-07",
                                "@DocumentCategory": "Photographic",
                                "@DocumentNumber": "123456",
                                "@DocumentType": "National Identity Card",
                                "@NameOnDocument": "etsts",
                                "@NameVerified": "No",
                                "@Original": "No",
                                "@PhotographVerified": "No",
                                "@PlaceOfIssue": "test",
                                "@ResidentialAddressVerified": "No",
                                "@SequenceNumber": "0",
                                "@UniqueID": "bc63e7c48b29"
                            }
                        ]
                    }
                ]
            }
        }
    }
}

Detailed description of each field:

Field Name	Description	Type	Path	Required	Enumerations	Note
ProofOfIdentity	Contains details of a document used to verify identity	object	Package.Content.Application.PersonApplicant.ProofOfIdentity
@UniqueID	System assigned unique identifier	string	Package.Content.Application.PersonApplicant.ProofOfIdentity	Yes		Mandatory if ProofOfIdentity exists
@DocumentType	The type of supporting document provided to verify the Party's identity	string	Package.Content.Application.PersonApplicant.ProofOfIdentity	Yes	New Zealand Passport, New Zealand Birth Certificate, New Zealand Certificate of Identity, New Zealand Citizenship Certificate, New Zealand Driver Licence, Medicare Card, National Identity Card, International Passport, Proof of Age Card, Other, Marriage Certificate	Mandatory if ProofOfIdentity exists
@DocumentCategory	Indication of whether the document is photographic, non photographic or secondary	string	Package.Content.Application.PersonApplicant.ProofOfIdentity		Secondary, Photographic, Non Photographic
@NameOnDocument	The name of the person for which the document is providing evidence of their identity	string	Package.Content.Application.PersonApplicant.ProofOfIdentity	Yes		Mandatory if ProofOfIdentity exists
@DocumentNumber	The identifying number of the document	string	Package.Content.Application.PersonApplicant.ProofOfIdentity	Yes		Mandatory if ProofOfIdentity exists
@VersionNumber		integer	Package.Content.Application.PersonApplicant.ProofOfIdentity	Yes		Mandatory if document type is New Zealand Driver Licence
@DateOfIssue	The date of issue or start date of the ID	date	Package.Content.Application.PersonApplicant.ProofOfIdentity
@ExpiryDate	The end date or expiry date of the ID	date	Package.Content.Application.PersonApplicant.ProofOfIdentity
@CountryOfIssue	The country from which the ID was issued	string	Package.Content.Application.PersonApplicant.ProofOfIdentity	Yes		Mandatory if document type is International Passport
@PlaceOfIssue	Holds the city where the document was issued. For overseas documents, the place or state of issue	string	Package.Content.Application.PersonApplicant.ProofOfIdentity
@Original	Flag to indicate whether the document is an original	string	Package.Content.Application.PersonApplicant.ProofOfIdentity		Yes, No
@CertifiedCopy	Indicates whether a certified copy of the proof of identity type has been provided	string	Package.Content.Application.PersonApplicant.ProofOfIdentity		Yes, No
@NameVerified	Flag to indicate that the applicants name is verified by the document	string	Package.Content.Application.PersonApplicant.ProofOfIdentity		Yes, No
@PhotographVerified	Captures whether the photograph of the applicant on the provided proof of identity document has been verified	string	Package.Content.Application.PersonApplicant.ProofOfIdentity		Yes, No
@DOBVerified	Flag to indicate that the applicants date of birth is verified by the document	string	Package.Content.Application.PersonApplicant.ProofOfIdentity		Yes, No
@ResidentialAddressVerified	Flag to indicate that the applicants residential is verified by the document	string	Package.Content.Application.PersonApplicant.ProofOfIdentity		Yes, No
@SignatureVerified	Indicates whether the signature of this Party has been verified by an approved representative of the lender	string	Package.Content.Application.PersonApplicant.ProofOfIdentity		Yes, No
@DateDocumentVerified	Indicates the date when the document was verified	date	Package.Content.Application.PersonApplicant.ProofOfIdentity

Party Proof of Identity

Sample Request

Detailed description of each field:

Reviews